home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1995 October / EnigmA AMIGA RUN 01 (1995)(G.R. Edizioni)(IT)[!][issue 1995-10][Aminet 7].iso / Aminet / dev / misc / ADView.lha / Autodoc / ReadMe < prev    next >
Text File  |  1995-05-03  |  4KB  |  113 lines
  1.  
  2.                              Autodoc View 1.0
  3.  
  4.                                     by
  5.  
  6.                               Jean-Guy Speton
  7.  
  8.                                 May 2, 1995
  9.  
  10.  
  11. This program uses triton.library, which is Copyright © Stefan Zeiger.
  12.  
  13.  
  14. DESCRIPTION
  15.  
  16. This program is a GUI viewer for your autodoc files, with a simple
  17. point-and-click interface.
  18.  
  19.  
  20. MOTIVATION
  21.  
  22. I've been a long-time user of Steve Bond's Autodoc program from 1992, but
  23. I always felt there were some features lacking.  Among them:
  24.  
  25.   · Inability to resize windows cuts off the right side of autodoc entries
  26.     which have long lines (which most do!).
  27.   · Topaz/8 hard-coded.
  28.   · The "double-click" system used to select autodoc entries would always
  29.     be activated at the wrong times, sometimes bringing up the same window
  30.     many times (most annoying).
  31.   · Only one entry could be open at any one time.
  32.   · Sometimes not all autodoc entries would show up, usually from the
  33.     end.
  34.  
  35. I also was wanting to write a program with triton.library and this seemed
  36. the perfect candidate for my first use of the library.  I'm very pleased
  37. with the results.
  38.  
  39.  
  40. BLATANT PLUG
  41.  
  42. At the time of this writing there is a debate raging on some of the
  43. comp.sys.amiga forums about the usefulness (and appropriateness) of MUI
  44. (MagicUserInterface).  In my own experiences, I've found the GUI of
  45. programs written with MUI to be slower than others.  With triton, I find
  46. the speed perfectly acceptable, and it certainly has made the development
  47. of this program easier (it was written in a day, whereas writing the
  48. equivalent GUI code using only GadTools would surely have taken me at least
  49. a week).
  50.  
  51. I guess what I'm trying to say is: if you don't like MUI, give triton a
  52. try.  It's not as powerful, but it's much smaller and noticeably quicker.
  53.  
  54. Here's hoping OS 3.2 (4.0?) comes with a library with similar functionality
  55. to either triton or MUI.  Standards are good.  :-)
  56.  
  57.  
  58. DISTRIBUTION
  59.  
  60. Autodoc, the source file, and all other files (excluding those in the
  61. Triton directory, which are © Stefan Zeiger) are public domain.
  62.  
  63.  
  64. DISCLAIMER
  65.  
  66. Use this program at your own risk.  This program comes with no warranties,
  67. either expressed or implied, of any kind.  You take all responsibility for
  68. the use (or misuse) of this program.  So there!
  69.  
  70.  
  71. INSTALLATION
  72.  
  73. Use the Install script in the Triton directory to install triton.library.
  74. Then move the Autodoc icon to wherever you want.  :-)
  75.  
  76.  
  77. OPERATION
  78.  
  79. Autodoc takes no arguments, simply execute it from the shell or WB.
  80.  
  81. Autodoc expects to find your autodoc files in the directory AUTODOC:.
  82. Assign it in your s:user-startup or something.
  83.  
  84. Autodoc expects your autodoc files be very similar (virtually exact) to the
  85. format of the official Commodore autodoc files.  This shouldn't be a
  86. problem: all third party autodoc files I've tried this program on also
  87. work.
  88.  
  89. There is no limit to the number of windows which Autodoc can open (well, I
  90. suppose your available RAM limits it somewhat).  To close a window simply
  91. click on its close gadget.
  92.  
  93. When you click on the close gadget of the top-level window (the listing of
  94. all autodoc files) the program will terminate, closing all other open
  95. windows (if any) in the process.  Autodoc also exits cleanly upon receipt
  96. of a CTRL-C (break) signal.  (Don't you wish all programs did this?)
  97.  
  98.  
  99. BUGS
  100.  
  101. There are no known bugs, but if you find any please let me know at
  102. jspeton@quest.blaze.bc.ca.
  103.  
  104. An improvement which probably should be made is to speed up the scanning of
  105. the autodoc files for the selected entry: at the moment it's rather slow.
  106.  
  107.  
  108. AUTHOR
  109.  
  110. Contact me at jspeton@quest.blaze.bc.ca for any reason.  If you (dis)like
  111. the program I'd like to hear from you.
  112.  
  113.